Bulk update Scenario Requirement Traceability and Status
Updates requirement traceability and status for multiple Scenarios.
Headers
| Header | Value |
|---|---|
user_id | Login username (email) |
api_key | API key of the user for authentication |
Content-Type | application/json |
Accept | application/json |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
accelqLoginUrl | string | Yes | The AccelQ login URL for API access. |
tenantCode | string | Yes | Tenant code for identifying the organization. |
projectCode | string | Yes | Project Code found under Auth properties of ACCELQ User Profile |
scenarioType | string | Yes | Scenario Type |
user_id | string | Yes | Login username (email) |
api_key | string | Yes | API key of the user for authentication |
Request Body
json
[
{
"scenarioIds": [
1,
2
],
"status": "In Progress",
"requirementTraceability": {
"requirementKeys": [
"TP-11",
"TP-31"
],
"updateType": "APPEND",
"externalIntegrationProject": "SanityWorkSpace"
}
},
{
"scenarioIds": [
98,
102
],
"status": "Completed",
"requirementTraceability": {
"requirementKeys": [
"TP-51",
"TP-319",
"TP-987"
],
"updateType": "OVERRIDE",
"externalIntegrationProject": "SanityWorkSpace"
}
}
]
Responses
200 - Bulk update completed with detailed results showing successfully updated Scenarios, checkout conflicts, and not found Scenario IDs.
json
{
"updatedEntities": [
1,
2,
3
],
"notUpdatedOthersCheckedOutEntities": [
4,
5
],
"notFoundEntities": [
10
]
}
400 - Bad Request - Validation errors
json
{
"error": "Request Body cannot be null or empty"
}
401 - Unauthorized - Invalid authentication credentials
json
{
"error": "Invalid user credentials or API key"
}
403 - Forbidden - User does not have permission to perform this operation
json
{
"error": "User does not have authorization to access this feature"
}
500 - Internal Server Error
json
{
"error": "Internal error occurred while requirements integration"
}
cURL Command Builder
URL Parameters
Headers
Request Sample (cURL)
curl -X PATCH "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/scn/scenarios/${{scenarioType}}/bulk-update" \
-H "user_id: ${{user_id}}" \
-H "api_key: ${{api_key}}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '[
{
"scenarioIds": [
1,
2
],
"status": "In Progress",
"requirementTraceability": {
"requirementKeys": [
"TP-11",
"TP-31"
],
"updateType": "APPEND",
"externalIntegrationProject": "SanityWorkSpace"
}
},
{
"scenarioIds": [
98,
102
],
"status": "Completed",
"requirementTraceability": {
"requirementKeys": [
"TP-51",
"TP-319",
"TP-987"
],
"updateType": "OVERRIDE",
"externalIntegrationProject": "SanityWorkSpace"
}
}
]'